remark-yaml

remark-yaml

Parse and stringify YAML code blocks in remark.

Supports IE9+ (mdn, Kangax).

Installation

npm

npm install remark-yaml

remark-yaml is also available for duo, and as an AMD, CommonJS, and globals module, uncompressed and compressed.

Table of Contents

• Usage

• API

  • remark.use(yaml, options)

• License

Usage

var yaml = require('remark-yaml');
var remark = require('remark').use(yaml);
var input = [
    '---',
    '"layout": "post"',
    '"title": \'Blogging Like a Hacker\'',
    '---',
    '',
    '# A header!',
    ''
].join('\n');
var tree = remark.parse(input);

The yaml node now has a yaml property.

var data = tree.children[0].yaml;

{
  "layout": "post",
  "title": "Blogging Like a Hacker"
}

Stringifying the document (note the formatting) yields:

var doc = remark.stringify(tree);

---
layout: post
title: Blogging Like a Hacker
---

# A header!

API

remark.use(yaml, options)

Adds a yaml property to YAML nodes.

Signatures

• remark = remark.use(yaml, options?).

Parameters

• yaml — This plugin;

• options (Object?) — Settings:

  • library (string? or Object?, default: nodeca/js-yaml) — you can also pass a file or node module in;

  • parse (string?, default "safeLoad");

  • stringify (string?, default "safeDump");

  • prettify (boolean?, default: true) — When true, the node’s content will be overwritten by the result of library[stringify](node.yaml);

  • onparse (function(Node), default function () {}) — Invoked when YAML is parsed, during parsing;

  • onstringify (function(Node), default function () {}) — Invoked when YAML is stringified, during stringification.

License

MIT © Titus Wormer